Leadtools.ImageOptimization Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
OptimizeBuffer(RasterCodecs,Byte[],Int32,Int32,ImageOptimizerOptions,ImageOptimizerProgress) Method
See Also  Example
Leadtools.ImageOptimization Namespace > ImageOptimizer Class > OptimizeBuffer Method : OptimizeBuffer(RasterCodecs,Byte[],Int32,Int32,ImageOptimizerOptions,ImageOptimizerProgress) Method



codecs
The RasterCodecs object used internally in the optimization operation.
buffer
The original image buffer in memory as a Byte array. The image format in memory should be one of the following supported formats:
offset
The number of bytes to offset the pointer that points to the buffer parameter" so that the data will be read starting from the "Buffer + Offset" position.
length
The length of the image buffer, in bytes, starting from the offset byte.
options
The options used in the optimization process.
progressCallback
Optional callback function that provides information about the progress of the optimization process.
Optimizes a supported image format buffer using the passed optimization options.

Syntax

Visual Basic (Declaration) 
Public Overloads Function OptimizeBuffer( _
   ByVal codecs As RasterCodecs, _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal length As Integer, _
   ByVal options As ImageOptimizerOptions, _
   ByVal progressCallback As ImageOptimizerProgress _
) As Byte()
Visual Basic (Usage)Copy Code
Dim instance As ImageOptimizer
Dim codecs As RasterCodecs
Dim buffer() As Byte
Dim offset As Integer
Dim length As Integer
Dim options As ImageOptimizerOptions
Dim progressCallback As ImageOptimizerProgress
Dim value() As Byte
 
value = instance.OptimizeBuffer(codecs, buffer, offset, length, options, progressCallback)
C# 
public byte[] OptimizeBuffer( 
   RasterCodecs codecs,
   byte[] buffer,
   int offset,
   int length,
   ImageOptimizerOptions options,
   ImageOptimizerProgress progressCallback
)
C++/CLI 
public:
array<byte>^ OptimizeBuffer( 
   RasterCodecs codecs,
   array<byte>^ buffer,
   int offset,
   int length,
   ImageOptimizerOptions options,
   ImageOptimizerProgress^ progressCallback
)

Parameters

codecs
The RasterCodecs object used internally in the optimization operation.
buffer
The original image buffer in memory as a Byte array. The image format in memory should be one of the following supported formats:
offset
The number of bytes to offset the pointer that points to the buffer parameter" so that the data will be read starting from the "Buffer + Offset" position.
length
The length of the image buffer, in bytes, starting from the offset byte.
options
The options used in the optimization process.
progressCallback
Optional callback function that provides information about the progress of the optimization process.

Return Value

A Byte array that contains the optimized image buffer in memory.

Example

This example will optimize a Jpg image file then save it into a separate folder

Visual BasicCopy Code
Public Sub TestJpegImageOptimizer()
   ' Initialize the RasterCodecs class
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   ' The input and output location
   Dim inputFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Slave.jpg"
   Dim outputFolder As String = LeadtoolsExamples.Common.ImagesPath.Path + "OptimizedImages"

   ' Initialize a new Optimizer object
   Dim optimizer As ImageOptimizer = New ImageOptimizer()

   ' Optimization Options
   Dim options As ImageOptimizerOptions = ImageOptimizerOptions.Default

   ' Set custom optimization options
   options.JpegQualityFactor = 255
   options.JpegColorSpace = ImageOptimizerJpegColorSpace.JpegColorSpace422

   ' Load the input file into a memory byte array
   Dim orgBuffer() As Byte = File.ReadAllBytes(inputFileName)

   ' Optimize this buffer
   Dim optBuffer() As Byte = optimizer.OptimizeBuffer(codecs, orgBuffer, 0, 0, options, AddressOf OptimizeBufferProgress)

   ' Save this image into the output folder
   ' Make sure the output folder exists
   If (Not Directory.Exists(outputFolder)) Then
      Directory.CreateDirectory(outputFolder)
   End If

   ' Get the name of the output file from the input file
   Dim outputFileName As String = Path.Combine(outputFolder, Path.GetFileName(inputFileName))

   ' Save the optimized buffer to the output file
   Using fs As FileStream = File.Create(outputFileName)
      fs.Write(optBuffer, 0, optBuffer.Length)
   End Using

   ' Compare the original image size with the optimized size
   Dim orgSize As Long = New FileInfo(inputFileName).Length
   Dim optSize As Long = New FileInfo(outputFileName).Length
   Dim percentage As Integer = CType(CType(optSize * 100.0 / orgSize, Double), Integer)

   Dim message As String = String.Format( _
      "Original image size: {0} KB{1}Optimized image size: {2} KB{1}Percentage: {3}%", _
      orgSize / 1024, Environment.NewLine, optSize / 1024, _
      100 - percentage)
   MessageBox.Show(message)

   'shutdown the RasterCodecs class.
   RasterCodecs.Shutdown()
End Sub

Public Shared Function OptimizeBufferProgress(ByVal percent As Integer) As Boolean
   Console.WriteLine(String.Format("{0}%", percent))
   Return True
End Function
C#Copy Code
public void TestJpegImageOptimizer( ) 
{ 
   // Initialize the RasterCodecs class 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // The input and output location 
   string inputFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Slave.jpg"; 
   string outputFolder = LeadtoolsExamples.Common.ImagesPath.Path + "OptimizedImages"; 
 
   // Initialize a new Optimizer object 
   ImageOptimizer optimizer = new ImageOptimizer(); 
 
   // Optimization Options 
   ImageOptimizerOptions options = ImageOptimizerOptions.Default; 
 
   // Set custom optimization options 
   options.JpegQualityFactor = 255; 
   options.JpegColorSpace = ImageOptimizerJpegColorSpace.JpegColorSpace422; 
 
   // Load the input file into a memory byte array 
   byte[] orgBuffer = File.ReadAllBytes(inputFileName); 
 
   // Optimize this buffer 
   byte[] optBuffer = optimizer.OptimizeBuffer(codecs, orgBuffer, 0, orgBuffer.Length, options, OptimizeBufferProgress); 
 
   // Save this image into the output folder 
   // Make sure the output folder exists 
   if(!Directory.Exists(outputFolder)) 
      Directory.CreateDirectory(outputFolder); 
 
   // Get the name of the output file from the input file 
   string outputFileName = Path.Combine(outputFolder, Path.GetFileName(inputFileName)); 
 
   // Save the optimized buffer to the output file 
   using(FileStream fs = File.Create(outputFileName)) 
      fs.Write(optBuffer, 0, optBuffer.Length); 
 
   // Compare the original image size with the optimized size 
   long orgSize = new FileInfo(inputFileName).Length; 
   long optSize = new FileInfo(outputFileName).Length; 
   int percentage = (int)((double)optSize * 100.0 / orgSize); 
 
   string message = string.Format( 
      "Original image size: {0} KB{1}Optimized image size: {2} KB{1}Percentage: {3}%", 
      orgSize / 1024, Environment.NewLine, optSize / 1024, 
      100 - percentage); 
   MessageBox.Show(message); 
 
   //shutdown the RasterCodecs class. 
   RasterCodecs.Shutdown(); 
} 
 
static bool OptimizeBufferProgress(int percent) 
{ 
   Console.WriteLine(string.Format("{0}%", percent)); 
   return true; 
}

Remarks

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also